Skip to content

Unified admonitions#3208

Merged
mnocon merged 1 commit into
5.0from
unify-admonitions
May 18, 2026
Merged

Unified admonitions#3208
mnocon merged 1 commit into
5.0from
unify-admonitions

Conversation

@mnocon

@mnocon mnocon commented May 17, 2026

Copy link
Copy Markdown
Contributor

Target: v5, 4.6

Our admonition usage is not consistent, we have a couple of these which compete with each other - and the warning and info ones use default MkDocs styling, not our custom one.

In this PR, I'm converting:

  • info -> note
  • warning -> caution

After this change, the usage is:

  • note: 350 total
  • tip: 194 tota
  • caution: 133 total

As a follow up, I'll add a vale rule checking these, to make sure we stay consistent.

@mnocon mnocon force-pushed the unify-admonitions branch from 0933bbf to ba8e2ea Compare May 18, 2026 09:42
@mnocon mnocon marked this pull request as ready for review May 18, 2026 09:45
@mnocon mnocon requested a review from a team May 18, 2026 09:45
@ibexa-workflow-automation-1 ibexa-workflow-automation-1 Bot requested review from adriendupuis, dabrt and julitafalcondusza and removed request for a team May 18, 2026 09:45
@sonarqubecloud

Copy link
Copy Markdown

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is not exposed in our table of contents. I know it was left behind to support some of our clients that used SS-based perso, but do we need it any more?

https://doc.ibexa.co/en/latest/personalization/legacy_recommendation_api/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it for now, at some point we'll rework the whole Personalization section

@mnocon mnocon merged commit ab35e94 into 5.0 May 18, 2026
15 checks passed
@mnocon mnocon deleted the unify-admonitions branch May 18, 2026 17:17
mnocon added a commit that referenced this pull request May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants